Added missing FailNow calls to sdkserver unit tests #1659

akremsa · 2020-06-30T13:06:07Z

What type of PR is this?

/kind bug
/kind cleanup

What this PR does / Why we need it:
There are places where in case of an error nil pointer exception will happen because assert.Fail() do not abort test execution. I followed the approach that we have discussed previously.

Special notes for your reviewer:
I've noticed that NewSDKServer function has return parameters *SDKServer, error , but actually it never returns an error. Why? It produces if err != nil checks where an error won't happen.

agones-bot · 2020-06-30T13:28:03Z

Build Succeeded 👏

Build Id: 81373876-db63-4eee-bce6-0fdc735e4d0c

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.7.0-7f88046
image: gcr.io/agones-images/agones-sdk:1.7.0-7f88046
image: gcr.io/agones-images/agones-ping:1.7.0-7f88046
Linux C++ SDK (build): agonessdk-1.7.0-7f88046-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.7.0-7f88046.zip

A preview of the website (the last 30 builds are retained):

https://7f88046-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1659/head:pr_1659 && git checkout pr_1659
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.7.0-7f88046

aLekSer · 2020-06-30T13:39:58Z

pkg/sdkserver/sdkserver_test.go

@@ -333,7 +333,9 @@ func TestSidecarUpdateState(t *testing.T) {
 		t.Run(k, func(t *testing.T) {
 			m := agtesting.NewMocks()
 			sc, err := defaultSidecar(m)
-			assert.Nil(t, err)
+			if err != nil {


I think this should be wrapped in a helper function.

It's just a matter of taste. I prefer the current style because if we introduce a function we need to copy it in every test file and when you read code you need to dig into that additional function to check what happens there. I prefer to keep things as simple as possible. I believe that function will become more and more complex in time with additional logic, logging parameters, and so on. I would like to avoid that.
Other opinions?

As another option, you can use the package require from testify library.
Package require implements the same assertions as the assert package but stops test execution when a test fails.
I found function NoError very useful for such cases when we want all preconditions to be completed fully or fail the test.

@oleg-balunenko good suggestion. Actually we can either continue following if err != nil { FailNow() } pattern or use another package to avoid these checks. I find assert methods descriptions a bit confusing, honestly.

No issues with pulling in require on my end - a little less noise in the code when wanting to fail fast.

Yes, let us use require, I also have found it, while investigating alternatives, and by the way it would make code more compact.
Fixing the link mentioned above
https://pkg.go.dev/github.com/stretchr/testify/require?tab=doc

agones-bot · 2020-07-07T22:10:35Z

Build Failed 😱

Build Id: b905a57d-bdda-4b08-b738-39f42b60d898

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2020-07-07T22:21:59Z

Build Failed 😱

Build Id: bfbeea48-a04d-4fbc-a5a1-f564d21995a4

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2020-07-07T22:52:27Z

Build Failed 😱

Build Id: 228a3078-dd3c-4404-9820-c567c5c97d11

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

use NoError fix added require to vendor

agones-bot · 2020-07-07T23:32:25Z

Build Succeeded 👏

Build Id: e6271cf8-dc94-401c-bcbc-dfc469d3c8f3

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.7.0-6146d8d
image: gcr.io/agones-images/agones-sdk:1.7.0-6146d8d
image: gcr.io/agones-images/agones-ping:1.7.0-6146d8d
Linux C++ SDK (build): agonessdk-1.7.0-6146d8d-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.7.0-6146d8d.zip

A preview of the website (the last 30 builds are retained):

https://6146d8d-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1659/head:pr_1659 && git checkout pr_1659
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.7.0-6146d8d

aLekSer

I like this version it is more readable now. 3 times more readable to be accurate.

google-oss-robot · 2020-07-08T16:28:48Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: akremsa, aLekSer
To complete the pull request process, please assign dzlier-gcp
You can assign the PR to them by writing /assign @dzlier-gcp in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

agones-bot · 2020-07-08T16:49:16Z

Build Succeeded 👏

Build Id: c4a8060c-5b51-4831-9a05-4c3cacd38a64

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.8.0-f59183c
image: gcr.io/agones-images/agones-sdk:1.8.0-f59183c
image: gcr.io/agones-images/agones-ping:1.8.0-f59183c
Linux C++ SDK (build): agonessdk-1.8.0-f59183c-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.8.0-f59183c.zip

A preview of the website (the last 30 builds are retained):

https://f59183c-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1659/head:pr_1659 && git checkout pr_1659
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.8.0-f59183c

) * added missing FailNow calls to sdkserver unit tests * use require package to abort a test use NoError fix added require to vendor Co-authored-by: Alexander Apalikov <[email protected]>

google-oss-robot requested review from markmandel and pooneh-m June 30, 2020 13:06

googlebot added the cla: yes label Jun 30, 2020

google-oss-robot added the size/L label Jun 30, 2020

aLekSer reviewed Jun 30, 2020

View reviewed changes

markmandel mentioned this pull request Jul 6, 2020

Fix tests timeout, WatchGameServer recent feature #1674

Merged

akremsa force-pushed the sdkserver_test_fix branch from 7f88046 to 4b4dbb1 Compare July 7, 2020 22:03

google-oss-robot added size/M and removed size/L labels Jul 7, 2020

akremsa force-pushed the sdkserver_test_fix branch from 4b4dbb1 to 78a41e3 Compare July 7, 2020 22:13

akremsa force-pushed the sdkserver_test_fix branch from 78a41e3 to eb4301f Compare July 7, 2020 22:35

google-oss-robot added size/XXL and removed size/M labels Jul 7, 2020

alexey-kremsa-globant added 2 commits July 8, 2020 02:02

added missing FailNow calls to sdkserver unit tests

42e4c9b

use require package to abort a test

6146d8d

use NoError fix added require to vendor

akremsa force-pushed the sdkserver_test_fix branch from eb4301f to 6146d8d Compare July 7, 2020 23:02

Merge branch 'master' into sdkserver_test_fix

f59183c

aLekSer approved these changes Jul 8, 2020

View reviewed changes

google-oss-robot assigned aLekSer Jul 8, 2020

google-oss-robot added the lgtm label Jul 8, 2020

aLekSer merged commit dd9b2d2 into googleforgames:master Jul 8, 2020

markmandel added this to the 1.8.0 milestone Aug 11, 2020

markmandel added the area/tests Unit tests, e2e tests, anything to make sure things don't break label Aug 11, 2020

markmandel added the kind/cleanup Refactoring code, fixing up documentation, etc label Aug 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added missing FailNow calls to sdkserver unit tests #1659

Added missing FailNow calls to sdkserver unit tests #1659

akremsa commented Jun 30, 2020 •

edited

Loading

agones-bot commented Jun 30, 2020

aLekSer Jun 30, 2020

akremsa Jun 30, 2020

obalunenko Jun 30, 2020 •

edited by aLekSer

Loading

akremsa Jul 1, 2020

markmandel Jul 6, 2020

aLekSer Jul 7, 2020 •

edited

Loading

agones-bot commented Jul 7, 2020

agones-bot commented Jul 7, 2020

agones-bot commented Jul 7, 2020

agones-bot commented Jul 7, 2020

aLekSer left a comment

google-oss-robot commented Jul 8, 2020

agones-bot commented Jul 8, 2020

Added missing FailNow calls to sdkserver unit tests #1659

Added missing FailNow calls to sdkserver unit tests #1659

Conversation

akremsa commented Jun 30, 2020 • edited Loading

agones-bot commented Jun 30, 2020

aLekSer Jun 30, 2020

Choose a reason for hiding this comment

akremsa Jun 30, 2020

Choose a reason for hiding this comment

obalunenko Jun 30, 2020 • edited by aLekSer Loading

Choose a reason for hiding this comment

akremsa Jul 1, 2020

Choose a reason for hiding this comment

markmandel Jul 6, 2020

Choose a reason for hiding this comment

aLekSer Jul 7, 2020 • edited Loading

Choose a reason for hiding this comment

agones-bot commented Jul 7, 2020

agones-bot commented Jul 7, 2020

agones-bot commented Jul 7, 2020

agones-bot commented Jul 7, 2020

aLekSer left a comment

Choose a reason for hiding this comment

google-oss-robot commented Jul 8, 2020

agones-bot commented Jul 8, 2020

akremsa commented Jun 30, 2020 •

edited

Loading

obalunenko Jun 30, 2020 •

edited by aLekSer

Loading

aLekSer Jul 7, 2020 •

edited

Loading